19e1a44c48
Remove ROUNDTRIP error reference ( #25609 )
2023-08-31 11:23:17 -07:00
0762e82bcc
Update ci-fix.md: upgrade Avocado stuff ( #25568 )
2023-08-28 20:29:01 -07:00
9e86a85f51
Update ci-fix.md: link with EngHub docs + cleanup ( #25518 )
2023-08-24 14:20:38 -07:00
c6c97bb383
[TypeSpec Docs] Recommend "npm ci" over "npm install" ( #25437 )
2023-08-24 12:05:58 -07:00
6d49d86b95
{AzureRESTAPISpecs} Broken link in Getting started with OpenAPI specifications content ( #25279 )
...
* Update Getting started with OpenAPI specifications.md
* Update documentation/Getting started with OpenAPI specifications.md
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
---------
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
2023-08-21 06:53:27 -07:00
33abb04305
TypeSpec Getting Started doc ( #25021 )
...
* TSP Getting Started
* update
* updated doc
* updated doc
* moved how to create PR from TypeSpec doc to rest-api-spec repo
* updated per PR comment
2023-08-04 14:08:22 -07:00
266dcae521
Update/remove obsolete docs ( #24946 )
2023-07-26 16:12:40 -07:00
c79ad4f9df
Update TypeSpec get started guide ( #24901 )
...
* Update TypeSpec get started guide
* Update documentation/typespec-rest-api-dev-process.md
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
---------
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
2023-07-21 10:07:09 -07:00
2ec9039692
Update ci-fix.md: add API Doc Preview TSG ( #24843 )
...
* Update ci-fix.md: add API Doc Preview TSG
2023-07-14 16:29:34 -07:00
ba2179b31b
Update ci-fix cadl -> TypeSpec update ( #24535 )
2023-07-10 08:49:20 -07:00
bc3238712f
initial WIP Typespec E2E doc ( #24343 )
...
* initial WIP Typespec E2E doc
* updated local commands
* Updated doc
2023-06-27 09:04:27 -07:00
1290a9dfec
Update ci-fix.md: Update LintDiff repro guidance ( #24280 )
2023-06-08 15:22:43 -07:00
de54b003ae
Update `ci-fix.md`: clarify `prettier` TSG ( #24174 )
...
* Update ci-fix.md: clarify prettier TSG
* Update ci-fix.md
* Update ci-fix.md
2023-05-25 16:52:19 -07:00
719eeab635
Updated common script part in typespec e2e doc ( #23875 )
...
* Updated common script part in typespec e2e doc
* Update documentation/typespec-end-to-end-scenarios.md
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
* Update documentation/typespec-end-to-end-scenarios.md
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
* Resolve comments
* Refactor the content
* Update bulletin
---------
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
2023-05-11 15:09:33 -07:00
69df3c5d42
Improve prettier instructions: add `npx tsc`. ( #23867 )
2023-05-09 15:01:34 -07:00
aeb7bf01df
Update prettier version and normalize all files ( #23763 )
...
Remove unecessary prettier scripts
2023-05-01 17:26:24 -07:00
be4adb7c26
pull out common chart of sdk generation ( #23768 )
2023-04-28 15:01:25 -07:00
e3e1404c3f
Update E2E document proposal ( #23756 )
...
* Update E2E document proposal
* TOC update
* Update color
* update
* update doc
2023-04-28 14:46:35 +08:00
772deae66e
Added typespec-e2e-scenarios ( #23715 )
2023-04-25 09:42:36 -07:00
dc34cfefbd
Update typespec-structure-guidelines.md ( #23527 )
...
Adding note to copy tspconfig.yaml from sample project. We found that user doesn't have right tspconfig.yaml in the spec PR.
2023-04-12 16:53:13 -07:00
97c5c70de4
update python doc ( #23518 )
2023-04-12 11:17:18 +08:00
b065afacb9
Update ci-fix.md: link to LintDiff rules.md + make the ruleset more discoverable ( #23509 )
2023-04-11 07:51:05 -07:00
9a46bdbfea
Convert sample project to TypeSpec ( #23168 )
2023-04-04 16:57:01 -07:00
9627e7e581
Updated sdk automation docs ( #23345 )
...
* Updated sdk automation docs
* Update documentation/sdkautomation/README.md
2023-04-03 09:50:25 +08:00
dbdac79ee7
Update Semantic-and-Model-Violations-Reference.md ( #22942 )
...
add example for LRO_RESPONSE_HEADER fix.
2023-03-07 14:31:41 +08:00
8af107b80a
update the doc of sdk automation pipeline ( #22812 )
...
* update the doc of sdk automation pipeline
* Update GenerateInputSchema.json
* Update README.md
* Update README.md
2023-03-07 12:18:08 +08:00
b6cdb7f08d
Add docs on running RESTler and capturing test recordings with RESTler and test-proxy. ( #22460 )
2023-02-17 15:06:23 +08:00
c94b5583e5
Update Cadl sample project ( #22229 )
...
* Update Cadl sample project
- Move sample project under specification folder
- remove project.json file from individual project
- Add global project.json file under specifications folder
2023-02-08 09:31:40 -08:00
3035214dea
{AzureRestApi} fixes Azure/azure-rest-api-specs#22326 Provide the right external facing docs for external contributors ( #22403 )
...
fixes Azure/azure-rest-api-specs#22326
Provide the right external facing docs for external contributors
2023-02-02 09:40:56 +08:00
8cf609cb9d
Update ci-fix.md ( #22377 )
2023-01-31 12:03:11 +08:00
32246a0658
Update cadl validation doc ( #22098 )
...
* wip
* update ci-fix for cadl validation
* remove unused file
* update
* update cadl validation
Co-authored-by: jianyexi <jianyxi@microsoft.com>
2023-01-20 10:20:30 +08:00
db511f9fb7
Added shared library guideline ( #22162 )
...
* Added shared library guidline
* Use sample project in example
2023-01-12 08:15:56 -08:00
40de159684
fix cadl sample ( #22146 )
...
* fix
* Update Widgets_ListWidgetsSample.json
* Update Widgets_ListWidgetsSample.json
2023-01-12 17:26:27 +08:00
38e580acd8
Updated Toc in cadl structure markdown document ( #22118 )
2023-01-10 10:41:25 +08:00
6c19212250
Adding cadl sample project ( #21722 )
...
* Adding cadl sample project
* cadl sample: packaqe.json & cadl-project.yaml (#21903 )
* cadl sample: packaqe.json & cadl-project.yaml
* Update cadl-project.yaml
* Use faked shared model
* Update documentation/cadl-sample-project/specification/contosowidgetmanager/Contoso.WidgetManager/cadl-project.yaml
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
* Update cadl-project.yaml
* Adjusted to minimum file set
* update .Net emitter configuration
* update java emitter config
* Fixed examples issues
* Fixed example style issue
Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
2023-01-09 22:21:35 +08:00
9bfb9a0eca
Document how to integrate test-proxy ( #21811 )
...
* document how to integrate test-proxy
* update doc
* fix comments
2023-01-09 14:30:10 +08:00
0accdabf2f
update api scenario schema ( #21836 )
...
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2022-12-12 11:30:12 +08:00
f194e2289d
update schema and add roleassign doc ( #21469 )
...
* update schema and add roleassign doc
* fix comment
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2022-11-08 16:54:43 +08:00
e77f2f011a
Update ci-fix.md ( #21443 )
2022-11-07 15:28:37 +08:00
fa8bd476e1
Update QuickStart.md ( #21405 )
...
* Update QuickStart.md
* Update QuickStart.md
2022-11-03 13:44:11 +08:00
21826324d0
Cadl repo structure guidelines ( #20893 )
2022-10-25 09:02:54 -07:00
d43cbc7023
add role assignment ( #21078 )
...
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2022-10-19 10:22:39 +08:00
71ceebe95c
Apiscenario auth ( #20589 )
...
* define authentication
* remove shareScope support
* support overriding operationId
* align with autorest auth options
2022-09-27 16:06:30 +08:00
f7a7c19ea5
Consolidate contributing guide ( #20590 )
...
* Consolidate contributing guide
* Delete depreacated doc
2022-09-27 16:03:49 +08:00
d343ffea04
Fix authentication script for RESTler ( #20673 )
...
The last line of the authentication script was truncated -- probably a bad copy/paste. This fixes it.
2022-09-20 14:29:09 +08:00
f19b25eb21
Update readme.md ( #20615 )
2022-09-07 14:16:48 +08:00
c07799235a
Add doc on authentication script for Restler ( #20475 )
...
* Add doc on authentication script for Restler
* Improve doc on authenticaion for RESTler
2022-09-02 16:16:11 +08:00
6707a23af4
Update GenerateABasicApiScenario.md ( #20496 )
2022-08-31 17:52:44 +08:00
049107d4b0
add breaking change and oad rule mapping ( #20021 )
...
* breaking change and oad rule mapping
* small fix
* use single category
2022-08-31 13:47:18 +08:00
151d27875c
update download restler config part ( #20408 )
...
* update download restler config part
* Added upload modified restler config and fix markdown format
* Update documentation/swagger-accuracy-report.md
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
2022-08-30 11:41:47 +08:00
df66d048c8
Add section on improving RESTler coverage to Swagger accuracy report. ( #20353 )
2022-08-25 09:01:56 +08:00
04e3442a66
Update swagger-accuracy-report.md ( #20295 )
2022-08-22 22:48:21 +08:00
08560e03b3
Added traffic validation document ( #20271 )
...
* Added traffic validation document
* Update per the feedback
2022-08-18 17:27:10 +08:00
352507b790
Add support for more scopes and update documentation ( #20124 )
...
* Add more scopes
* update documentation
* fix some wording
* wording
* fix artifact name
* fix comment
* fix title
* rename files
2022-08-08 16:37:46 +08:00
03c410c866
Update ci-fix.md add apiReadinessCheck ( #20061 )
...
* Update ci-fix.md
* Update ci-fix.md
Minor change on wording.
Co-authored-by: Ray Chen <raychen@microsoft.com>
2022-08-03 12:26:54 +08:00
dc32b9ab46
format fix ( #20032 )
2022-08-01 11:49:30 +08:00
a63ddbed57
Dpg and ApiView integration doc ( #19122 )
2022-08-01 10:37:15 +08:00
64d1545fcb
Update ci-fix.md ( #19821 )
2022-07-27 18:17:05 +08:00
52e6e6ab0f
Update ci-fix.md ( #19972 )
2022-07-27 10:24:18 +08:00
402c7fb924
Apiscenario doc ( #19896 )
...
* update doc
* gitignore
* ci-fix
* update quickstart
* oav run -h
* resize image
* fix screenshot
* generation
* arm template
* update reference
* fix hashtag
2022-07-26 17:42:06 +08:00
23abda76e5
doc: add SDK test section to config doc ( #19828 )
...
* doc: add SDK test section to config doc
* platform resilient
* fix duplication
2022-07-26 11:25:02 +08:00
a9e895ccfe
Clarify prettier ci-fix instructions ( #19753 )
2022-07-15 16:14:56 +08:00
bbd29db1fe
Update ci-fix.md ( #19756 )
...
* Update ci-fix.md
* Update ci-fix.md
Updated link of oav readme.
Co-authored-by: Ray Chen <raychen@microsoft.com>
2022-07-13 17:46:00 +08:00
f68e478437
Update go SDK config doc ( #19526 )
...
* update go sdk config doc
* change to go-sdk-folder
2022-06-21 18:52:54 +08:00
9d789cce90
update schema ( #19528 )
...
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2022-06-20 15:42:35 +08:00
c943ce5e08
Change config of SDK automation for Go ( #19364 )
...
* remove go track1 sdk automation config
* change all md config for go automation
2022-06-14 13:59:27 +08:00
bacf902c3c
Update schema.json ( #19331 )
2022-06-06 15:58:48 +08:00
33338b8c70
Update configure-python-sdk.md ( #19157 )
2022-06-06 10:22:17 +08:00
ef2dedc629
update schema ( #19271 )
...
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2022-05-31 14:12:59 +08:00
4716fb039c
Enable azure-powershell CI for all management RPs ( #18771 )
...
* Enable azure-powershell for all manage RPs
* Change integrationRepository to Azure/azure-powershell-pr
* Change azure-powershell in api-spec repo
* Change azure-powershell in api-spec repo
* Remove azure-powershell from some deprecated RPs
Co-authored-by: v-yuzhichen@microsoft.com <v-yuzhichen@microsoft.com>
2022-04-22 10:31:17 +08:00
b5d8eef5bf
[Doc]update doc for configure-python-sdk ( #18618 )
...
* update doc
* Update configure-python-sdk.md
* Update configure-python-sdk.md
* Update configure-python-sdk.md
2022-04-20 16:44:01 +08:00
f560f78c86
Update openapi-authoring-automated-guidelines.md ( #18420 )
...
* Update openapi-authoring-automated-guidelines.md
* Update openapi-authoring-automated-guidelines.md
2022-04-12 17:31:45 +08:00
14007e94fb
apiscenario doc ( #18476 )
...
* sync signalr test scenarios
* remove extra template.json
* add asc scenarios file
* add uploadJar scripts
* add uploadJar
* add deploymentScripts
* update readme
* update doc and use blob sas url to download
* delete unused powershell file and format scripts
* adjust asc scenarios file
* update springCloud test scenario
* update powershell scripts
* v2 schema
* fix
* prettier
* securestring
* fix action
* fix
* fit 2.9.0, waiting for verify
* fix domainName
* json to yaml
* fix output variable type
* remove redundent defaultValue in armTemplate
* generate uniq name
* Adapt to v1.1 schema
* remove unnecesary file
* fix patch step
* update springCloud test scenario
* update spring cloud yaml
* prettier
* add overwrite variable
* new schema
* delete unused file
* rename armTemplateDeployment to armTemplate
* webpubsub
* v1.2 schema
* v1.2 schema
* webpubsub
* v1.2 schema
* adapt asc/signalr to v1.2 schema
* more data types in v1.2 schema
* v1.2 schema
* convert to new syntax
* restore example
* tiny change
* refine variables schema
* fix scenarios
* fix scenarios
* signalr basic crud
* cdn scenario coverage 57%
* add responses schema
* use readmeTag insteadof swagger
* fix rp
* fix schema
* fix step scope variables
* fix step variables
* fix
* [ApiScenario] update doc (#18424 )
* update doc
* Update documentation/api-scenario/how-to/generateABasicApiScenario.md
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com>
* update docs
* fix schema
* Update variables.md
* commit scenario files
* remove scenario files
* update schema line
* remove resourceUpdate
* remove resourceUpdate
* requestUpdate convention
* convention in pseudo-code
Co-authored-by: Zhenglai Zhang <zhenglaizhang@hotmail.com>
Co-authored-by: Songbo Wang <sonwan@microsoft.com>
Co-authored-by: ruowan <ruowan@microsoft.com>
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
Co-authored-by: tianxchen-ms <403562789@qq.com>
2022-04-08 13:22:56 +08:00
d45e9560ed
Update Breaking changes guidelines.md ( #18118 )
...
this page need to be deprecated
2022-03-25 17:19:30 +08:00
a543ec9b2e
Update ContributingGuidelines.md ( #18119 )
...
to fix broken link and stale content
2022-03-25 17:18:15 +08:00
9aff6fbac1
Update readme.python.md ( #18147 )
2022-03-15 10:08:37 +08:00
24b1f9ed9a
Update x-ms-examples.md ( #17819 )
...
* Update x-ms-examples.md
* Update x-ms-examples.md
* Update x-ms-examples.md
2022-02-14 15:49:38 +08:00
46a7b5a006
Update document of OAV error definitions ( #17206 )
...
* Update document of OAV error definitions
* Added reference link in description
2022-01-06 10:22:53 +08:00
eeb8e0a0fd
add new rule XmsIdentifierValidation doc ( #17076 )
...
* add new rule XmsIdentifierValidation doc
* fix comment
* fix comment
* fix comment
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2021-12-16 11:35:45 +08:00
6d812afded
Update openapi-authoring-automated-guidelines.md ( #17101 )
2021-12-15 13:39:19 +08:00
3ad7a853aa
add deployment script and rename armTemplateDeployment to armTemplate ( #16894 )
...
* add deployment script and rename armTemplateDeployment to armTemplate
* fix comments
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2021-11-29 14:33:21 +08:00
627150f8d1
add new lint rules doc ( #16712 )
...
* add two rules
* add index
* fix typo
* add a new rule
* update category
* fix comments
* fix comments
Co-authored-by: jianye xi <jianyxi@microsoft.com>
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2021-11-26 17:28:14 +08:00
67f2359692
add new error types of discriminator ( #16779 )
...
* add new error types
* rename error type
* update error msg
* update error description
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2021-11-23 09:07:24 +08:00
1f0ffef830
Update rules-for-release-request.md ( #16741 )
2021-11-11 10:18:39 +08:00
c0f5f5f439
add new error type DISCRIMINATOR_PROPERTY_TYPE_NOT_STRING ( #16676 )
...
Co-authored-by: Tianxiang Chen <tianxchen@microsoft.com>
2021-11-05 12:53:26 +08:00
c24ee32fb9
Guidance and rules for release request ( #16561 )
...
* 0.1.0
* update
* format
2021-10-28 10:40:48 +08:00
4aebac1bd7
Josefree doc update ( #16457 )
...
* Create Sample Directory Structure for Swagger
* Delete Sample Directory Structure for Swagger
* Create Sample Directory Structure for Swagger
* Update Getting started with OpenAPI specifications.md
* Delete Sample Directory Structure for Swagger
will reuse this wiki https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure , instead of creating a new one.
* Update Getting started with OpenAPI specifications.md
reuse this wiki for sample directory https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure
2021-10-22 11:42:02 +08:00
53f959c01f
Update description for ENUM_MISMATCH error code. ( #16351 )
2021-10-12 10:37:01 +08:00
3a4009988e
update api scenario documentation ( #16086 )
...
* add operation step
* fix schema
* restore OpTest
* add cleanUpSteps & remove type
* use draft-07 schema
* refine propertyNames
* add description
* remove merge
* fix copy/move
* use property name
* variable type
* restore plain style
* define Example and file reference in v1.1
* remove raw Example support
* fix
* rename to API scenario
* restore entry
* fix ref
2021-10-11 13:26:37 +08:00
a7e864e0ea
Modify module-name released ( #16317 )
...
* add resourcemanager and add repo for go track2
* add resourcemanager
* fix other
2021-10-09 14:28:55 +08:00
699c3a00cf
Fix example for XmsClientNameParameter rule ( #16019 )
...
* Fix example for XmsClientNameParameter rule
* Address PR review comments
2021-09-27 10:52:08 +08:00
fa142b5613
change readme.go.md template to track 2 ( #15972 )
2021-09-09 11:19:05 +08:00
f1f04833e9
Add docs for test scenario ( #15437 )
...
* Add docs for test scenario
* fix markdown
* update doc
* update readme
* update readme
* improve folder structure
* move errorCode reference
* update
* add brief introduction
* fix doc
* Add contentVersion
* fix sample
* add caution
* fix link
* change schema folder
* features
* fix command
* fix
* update png
* add jsonpathopmove
* update readme
* refine schema
Co-authored-by: Lei Ni <leni@microsoft.com>
Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com>
2021-08-09 17:27:14 +08:00
81bfcf207b
update ci-fix ( #14887 )
...
* update how to fix
* fix comment
* fix
* up
* fix typo
* fix typo
* modified: documentation/ci-fix.md
Co-authored-by: jianyexi <jianyxi@microsoft.com>
2021-08-02 10:32:57 +08:00
84daa99e7c
Add Good/Bad edge case examples to R3016 ( #15043 )
...
From https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-1.1/141e06ef(v=vs.71)?redirectedfrom=MSDN :
> When using acronyms, use Pascal case or camel case for acronyms more than two characters long
and
> However, you should capitalize acronyms that consist of only two characters, such as System.IO instead of System.Io.
2021-07-21 08:54:42 +08:00
5af197915f
change the template for readme.go.md for openapihub to track 2 style ( #15065 )
2021-07-07 12:49:02 +08:00
f1db2c5649
doc example bug fix ( #14754 )
2021-07-02 11:15:40 +08:00
2e296c8b7f
doc bug fix ( #14733 )
2021-06-10 13:46:49 +08:00
a380bd6b6c
Update openapi-authoring-automated-guidelines.md ( #13859 )
...
* add rule
Co-authored-by: jianye xi <jianyxi@microsoft.com>
2021-06-01 13:50:33 +08:00
57347179dc
Delete readme.azureresourceschema.md ( #14224 )
...
* Delete readme.azureresourceschema.md
* Update samplereadme.md
* Delete reeadme.azureresourceschema.md
2021-05-06 11:05:35 +08:00
Shenglong Li
Konrad Jamrozik
Mike Harder
navba-MSFT
Allen Zhang
Mike Kistler
Wes Haggard
Ray Chen
Yuchao Yan
Wei Dong
Jianye Xi
Lei Ni
Tianxiang Chen
Travis Prescott
Ruoxuan Wang
marina-p
Jeffrey Richter
Chenjie Shi
Cole O'Brien
Xiaogang
Jiefeng Chen
Josephine Qiu
JiahuiPeng
Arcturus
Phoenix He
Teddy Todorov