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

EXPLOC-2366: Updating Locations.swagger2.json and markdown file #1304

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

EXPLOC-2366: Updating Locations.swagger2.json and markdown file #1304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e33063d
Updating Locations.swagger2.json and markdown file
swarooprath396 Jan 9, 2025
0a13b1b
Checking username
swarooprath396 Jan 9, 2025
14bca2e
Updating LocationUuid to LocationNameId
swarooprath396 Jan 10, 2025
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
8 changes: 6 additions & 2 deletions src/api-explorer/v3-0/Locations.swagger2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@
"tags": [
"Resources"
],
"summary": "Retrieves a location by ID.",
"summary": "Retrieves a location by ID or UUID.",
"description": "Gets details of the specified location.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the location.",
"description": "The ID or UUID of the location.",
"required": true,
"type": "string"
}
Expand Down Expand Up @@ -186,6 +186,10 @@
"URI": {
"type": "string",
"description": "The URI to the resource."
},
"LocationNameId": {
"type": "string",
"description": "The unique universal identifier of the resource."
}
}
},
Expand Down
3 changes: 2 additions & 1 deletion src/api-reference/common/locations/v3.locations.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ GET /api/v3.0/common/locations/{id}

Name|Type|Format|Description
---|---|---|---
`id`|`string`|`path`|**Required** The ID of the location.
`id`|`string`|`path`|**Required** The ID or UUID of the location.

## Schema <a name="schema"></a>

Expand All @@ -71,3 +71,4 @@ Name|Type|Format|Description
`Longitude`|`Decimal`|-|The longitude of the geocode for the location.
`Name`|`string`|-|The location name. Maximum length: 64 characters
`URI`|`string`|-|The URI to the resource.
`LocationNameId`|`string`|-|The unique universal identifier of the resource.