Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

APIM: improve developer portal operations docs #13941

Merged
merged 4 commits into from
Apr 20, 2021
Merged

APIM: improve developer portal operations docs #13941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc99bed
APIM: improve the documentation for dev portal operations
mikebudzynski Apr 14, 2021
d702e58
Minor changes
mikebudzynski Apr 14, 2021
ba256da
Removing OData parameters from the stable API version
mikebudzynski Apr 14, 2021
7e78b95
Remove new query params
mikebudzynski Apr 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions ...resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/apimcontenttypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"ContentType"
],
"operationId": "ContentType_ListByService",
"description": "Returns list of content types",
"description": "Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.",
"x-ms-examples": {
"ApiManagementListContentTypes": {
"$ref": "./examples/ApiManagementListContentTypes.json"
Expand All @@ -62,7 +62,7 @@
],
"responses": {
"200": {
"description": "Lists a collection of content type entities.",
"description": "Returns a collection of the Content Type entities.",
"schema": {
"$ref": "./definitions.json#/definitions/ContentTypeCollection"
}
Expand All @@ -85,7 +85,7 @@
"ContentType"
],
"operationId": "ContentType_Get",
"description": "Gets API Management content type details.",
"description": "Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.",
"x-ms-examples": {
"ApiManagementGetContentType": {
"$ref": "./examples/ApiManagementGetContentType.json"
Expand All @@ -110,7 +110,7 @@
],
"responses": {
"200": {
"description": "Get the details of the content type.",
"description": "Returns the details of the specified content type.",
"schema": {
"$ref": "./definitions.json#/definitions/ContentTypeContract"
},
Expand All @@ -134,7 +134,7 @@
"ContentType"
],
"operationId": "ContentType_CreateOrUpdate",
"description": "Creates or updates an Content Type.",
"description": "Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.",
"x-ms-examples": {
"ApiManagementCreateContentType": {
"$ref": "./examples/ApiManagementCreateContentType.json"
Expand Down Expand Up @@ -162,7 +162,7 @@
],
"responses": {
"201": {
"description": "Content type was successfully created.",
"description": "The content type was successfully created.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
Expand Down Expand Up @@ -198,7 +198,7 @@
"ContentType"
],
"operationId": "ContentType_Delete",
"description": "Removes specified content type.",
"description": "Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.",
"x-ms-examples": {
"ApiManagementDeleteContentType": {
"$ref": "./examples/ApiManagementDeleteContentType.json"
Expand Down Expand Up @@ -246,7 +246,7 @@
"ContentTypeContentItem"
],
"operationId": "ContentItem_ListByService",
"description": "Returns list of content items",
"description": "Lists developer portal's content items specified by the provided content type.",
"x-ms-examples": {
"ApiManagementListContentTypeContentItems": {
"$ref": "./examples/ApiManagementListContentTypeContentItems.json"
Expand All @@ -271,7 +271,7 @@
],
"responses": {
"200": {
"description": "Lists a collection of Content Type entities.",
"description": "Returns a collection of Content Type entities.",
"schema": {
"$ref": "./definitions.json#/definitions/ContentItemCollection"
}
Expand All @@ -294,7 +294,7 @@
"ContentTypeContentItem"
],
"operationId": "ContentItem_GetEntityTag",
"description": "Returns content item metadata",
"description": "Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.",
"x-ms-examples": {
"ApiManagementHeadContentTypeContentItem": {
"$ref": "./examples/ApiManagementHeadContentTypeContentItem.json"
Expand Down Expand Up @@ -343,7 +343,7 @@
"ContentTypeContentItem"
],
"operationId": "ContentItem_Get",
"description": "Returns content item details",
"description": "Returns the developer portal's content item specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetContentTypeContentItem": {
"$ref": "./examples/ApiManagementGetContentTypeContentItem.json"
Expand Down Expand Up @@ -371,7 +371,7 @@
],
"responses": {
"200": {
"description": "Get the details of the content item.",
"description": "Returns the content item.",
"schema": {
"$ref": "./definitions.json#/definitions/ContentItemContract"
},
Expand All @@ -395,7 +395,7 @@
"ContentTypeContentItem"
],
"operationId": "ContentItem_CreateOrUpdate",
"description": "Creates new content item",
"description": "Creates a new developer portal's content item specified by the provided content type.",
"x-ms-examples": {
"ApiManagementCreateContentTypeContentItem": {
"$ref": "./examples/ApiManagementCreateContentTypeContentItem.json"
Expand Down Expand Up @@ -426,7 +426,7 @@
],
"responses": {
"201": {
"description": "Content item was successfully created.",
"description": "The content item was successfully created.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
Expand Down Expand Up @@ -462,7 +462,7 @@
"ContentTypeContentItem"
],
"operationId": "ContentItem_Delete",
"description": "Removes specified content item.",
"description": "Removes the specified developer portal's content item.",
"x-ms-examples": {
"ApiManagementDeleteContentTypeContentItem": {
"$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json"
Expand Down
18 changes: 9 additions & 9 deletions ...ource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/apimportalrevisions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"PortalRevision"
],
"operationId": "PortalRevision_ListByService",
"description": "Lists a collection of developer portal revision entities.",
"description": "Lists developer portal's revisions.",
"x-ms-examples": {
"ApiManagementListPortalRevisions": {
"$ref": "./examples/ApiManagementListPortalRevisions.json"
Expand Down Expand Up @@ -75,7 +75,7 @@
],
"responses": {
"200": {
"description": "Lists a collection of developer portal revision entities.",
"description": "Lists portal's revisions.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionCollection"
}
Expand All @@ -98,7 +98,7 @@
"PortalRevision"
],
"operationId": "PortalRevision_GetEntityTag",
"description": "Gets developer portal revision specified by its identifier.",
"description": "Gets the developer portal revision specified by its identifier.",
"x-ms-examples": {
"ApiManagementHeadPortalRevision": {
"$ref": "./examples/ApiManagementHeadPortalRevision.json"
Expand All @@ -123,7 +123,7 @@
],
"responses": {
"200": {
"description": "Specified Portal revision entity exists and current entity state version is present in the ETag header.",
"description": "The specified portal revision entity exists and current entity state version is present in the ETag header.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
Expand All @@ -144,7 +144,7 @@
"PortalRevision"
],
"operationId": "PortalRevision_Get",
"description": "Gets developer portal revision specified by its identifier.",
"description": "Gets the developer portal's revision specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetPortalRevision": {
"$ref": "./examples/ApiManagementGetPortalRevision.json"
Expand All @@ -169,7 +169,7 @@
],
"responses": {
"200": {
"description": "Gets the specified developer portal revision entity.",
"description": "Gets the specified portal's revision.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
},
Expand All @@ -193,7 +193,7 @@
"PortalRevision"
],
"operationId": "PortalRevision_CreateOrUpdate",
"description": "Creates a new developer portal revision.",
"description": "Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.",
"x-ms-examples": {
"ApiManagementCreatePortalRevision": {
"$ref": "./examples/ApiManagementCreatePortalRevision.json"
Expand Down Expand Up @@ -226,10 +226,10 @@
],
"responses": {
"202": {
"description": "Request to create developer portal revision was accepted."
"description": "Request to create a developer portal revision was accepted."
},
"201": {
"description": "Developer portal revision was successfully created.",
"description": "The developer portal revision was successfully created.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
},
Expand Down
Loading