/fsfd/User/user_key
or
/fsfd/User/email_address
\n
Could you please provide some examples of how the actual URLs look like?
\nDo they look like this?
\nhttps://dev.test.com/xapis/User/abcde123545\nhttps://dev.test.com/xapis/User/user@example.com","body@stripHtml({\"removeProcessingText\":false,\"removeSpoilerMarkup\":false,\"removeTocMarkup\":false,\"truncateLength\":200})@stringLength":"218","kudosSumWeight":0,"postTime":"2019-06-03T07:59:35.502-07:00","lastPublishTime":"2019-06-03T07:59:35.502-07:00","metrics":{"__typename":"MessageMetrics","views":8691},"visibilityScope":"PUBLIC","placeholder":false,"originalMessageForPlaceholder":null,"isEscalated":null,"solution":false,"entityType":"FORUM_REPLY","eventPath":"category:swagger-os-community/community:nwkab66374board:SwaggerOSTools/message:185303/message:185379","replies":{"__typename":"MessageConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[{"__typename":"MessageEdge","cursor":"MjUuMnwyLjF8b3wzfDE0OjAsMzk6MXwx","node":{"__ref":"ForumReplyMessage:message:185380"}}]},"customFields":[],"editFrozen":false,"body@stringLength":"483","rawBody":"
Hi Kevin,
\n\n
An enum specifies the actual values for a parameter, so your definition means that the URL can be literally either
/fsfd/User/user_key
or
/fsfd/User/email_address
\n
Could you please provide some examples of how the actual URLs look like?
\nDo they look like this?
\nhttps://dev.test.com/xapis/User/abcde123545\nhttps://dev.test.com/xapis/User/user@example.com","images":{"__typename":"AssociatedImageConnection","edges":[],"totalCount":0,"pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null}},"attachments":{"__typename":"AttachmentConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[]},"timeToRead":1,"currentRevision":{"__ref":"Revision:revision:185379_1"},"latestVersion":null,"messagePolicies":{"__typename":"MessagePolicies","canModerateSpamMessage":{"__typename":"PolicyResult","failureReason":{"__typename":"FailureReason","message":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","key":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","args":[]}}}},"ModerationData:moderation_data:185380":{"__typename":"ModerationData","id":"moderation_data:185380","status":"APPROVED","rejectReason":null,"isReportedAbuse":false,"rejectUser":null,"rejectTime":null,"rejectActorType":null},"ForumReplyMessage:message:185380":{"__typename":"ForumReplyMessage","uid":185380,"id":"message:185380","revisionNum":1,"author":{"__ref":"User:user:84150"},"readOnly":false,"repliesCount":6,"depth":2,"hasGivenKudo":false,"subscribed":false,"board":{"__ref":"Forum:board:SwaggerOSTools"},"parent":{"__ref":"ForumReplyMessage:message:185379"},"conversation":{"__ref":"Conversation:conversation:185303"},"subject":"Re: Examples for enum Choices","moderationData":{"__ref":"ModerationData:moderation_data:185380"},"body":"
Yes, that is exactly how the different choices work.
\n\n
The example thta I already presented is as close to the actual API as I could give in a public forum.
\n\n
Thanks,
\n\n
Kevin
\n\n
\n
","body@stripHtml({\"removeProcessingText\":false,\"removeSpoilerMarkup\":false,\"removeTocMarkup\":false,\"truncateLength\":200})@stringLength":"230","kudosSumWeight":0,"postTime":"2019-06-03T08:02:33.872-07:00","lastPublishTime":"2019-06-03T08:02:33.872-07:00","metrics":{"__typename":"MessageMetrics","views":8673},"visibilityScope":"PUBLIC","placeholder":false,"originalMessageForPlaceholder":null,"isEscalated":null,"solution":false,"entityType":"FORUM_REPLY","eventPath":"category:swagger-os-community/community:nwkab66374board:SwaggerOSTools/message:185303/message:185380","replies":{"__typename":"MessageConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[{"__typename":"MessageEdge","cursor":"MjUuMnwyLjF8b3wxfDE0OjAsMzk6MXwx","node":{"__ref":"ForumReplyMessage:message:185385"}}]},"customFields":[],"editFrozen":false,"body@stringLength":"280","rawBody":"
Yes, that is exactly how the different choices work.
\n\n
The example thta I already presented is as close to the actual API as I could give in a public forum.
\n\n
Thanks,
\n\n
Kevin
\n\n
\n
","images":{"__typename":"AssociatedImageConnection","edges":[],"totalCount":0,"pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null}},"attachments":{"__typename":"AttachmentConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[]},"timeToRead":1,"currentRevision":{"__ref":"Revision:revision:185380_1"},"latestVersion":null,"messagePolicies":{"__typename":"MessagePolicies","canModerateSpamMessage":{"__typename":"PolicyResult","failureReason":{"__typename":"FailureReason","message":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","key":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","args":[]}}}},"ModerationData:moderation_data:185385":{"__typename":"ModerationData","id":"moderation_data:185385","status":"APPROVED","rejectReason":null,"isReportedAbuse":false,"rejectUser":null,"rejectTime":null,"rejectActorType":null},"ForumReplyMessage:message:185385":{"__typename":"ForumReplyMessage","author":{"__ref":"User:user:12406"},"id":"message:185385","revisionNum":1,"uid":185385,"depth":3,"hasGivenKudo":false,"subscribed":false,"board":{"__ref":"Forum:board:SwaggerOSTools"},"parent":{"__ref":"ForumReplyMessage:message:185380"},"conversation":{"__ref":"Conversation:conversation:185303"},"subject":"Re: Examples for enum Choices","moderationData":{"__ref":"ModerationData:moderation_data:185385"},"body":"
It can be defined as follows:
\n'/fsfd/User/{first_key}':\n get:\n tags:\n - User\n summary: Retrieve information on a user.\n description: 'Use GET to retrieve information on a user. To do this, specify the user key or email address immediately after /xapis/User/.'\n parameters:\n - name: first_key\n in: path\n description: A user key (for example, _abcde12345_) or email address (for example, _user@example.com_).\n required: true\n schema:\n type: string\n example: 'user@example.com'","body@stripHtml({\"removeProcessingText\":false,\"removeSpoilerMarkup\":false,\"removeTocMarkup\":false,\"truncateLength\":200})@stringLength":"203","kudosSumWeight":0,"repliesCount":5,"postTime":"2019-06-03T08:44:17.810-07:00","lastPublishTime":"2019-06-03T08:44:17.810-07:00","metrics":{"__typename":"MessageMetrics","views":8643},"visibilityScope":"PUBLIC","placeholder":false,"originalMessageForPlaceholder":null,"isEscalated":null,"solution":false,"entityType":"FORUM_REPLY","eventPath":"category:swagger-os-community/community:nwkab66374board:SwaggerOSTools/message:185303/message:185385","customFields":[],"readOnly":false,"editFrozen":false,"body@stringLength":"957","rawBody":"
\n # Or with multiple examples\n # (but this is not supported in Swagger UI and Editor yet)\n # examples:\n # user_key:\n # summary: Example of a user key\n # value: abcde12345\n # email_address:\n # summary: Example of an email address\n # value: 'user@example.com'
It can be defined as follows:
\n'/fsfd/User/{first_key}':\n get:\n tags:\n - User\n summary: Retrieve information on a user.\n description: 'Use GET to retrieve information on a user. To do this, specify the user key or email address immediately after /xapis/User/.'\n parameters:\n - name: first_key\n in: path\n description: A user key (for example, _abcde12345_) or email address (for example, _user@example.com_).\n required: true\n schema:\n type: string\n example: 'user@example.com'","images":{"__typename":"AssociatedImageConnection","edges":[],"totalCount":0,"pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null}},"attachments":{"__typename":"AttachmentConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[]},"timeToRead":1,"currentRevision":{"__ref":"Revision:revision:185385_1"},"latestVersion":null,"messagePolicies":{"__typename":"MessagePolicies","canModerateSpamMessage":{"__typename":"PolicyResult","failureReason":{"__typename":"FailureReason","message":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","key":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","args":[]}}}},"QueryVariables:MessageSolutions":{"__typename":"QueryVariables","id":"MessageSolutions","value":{"first":10,"constraints":{"topicId":{"eq":"message:185303"},"solution":{"eq":true}},"sorts":{"postTime":{"direction":"ASC"}},"useAvatar":true,"useAuthorLogin":true,"useAuthorRank":false,"useBody":true,"useKudosCount":false,"useTimeToRead":false,"useMedia":true,"useRepliesCount":false,"useSearchSnippet":false,"useAcceptedSolutionButton":true,"useSolvedBadge":false,"useAttachments":true,"useTags":false,"useUserHoverCard":false,"useNodeHoverCard":false,"usePreviewSubjectModal":false,"useMessageStatus":false}},"CachedAsset:text:en_US-components/messages/EscalatedMessageBanner-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/EscalatedMessageBanner-1741125846000","value":{"escalationMessage":"Escalated to Salesforce by {username} on {date}","viewDetails":"View Details","modalTitle":"Case Details","escalatedBy":"Escalated by: ","escalatedOn":"Escalated on: ","caseNumber":"Case Number: ","status":"Status: ","lastUpdateDate":"Last Update: ","automaticEscalation":"automatic escalation","anonymous":"Anonymous"},"localOverride":false},"CachedAsset:text:en_US-components/users/UserLink-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/users/UserLink-1741125846000","value":{"authorName":"View Profile: {author}","anonymous":"Anonymous"},"localOverride":false},"CachedAsset:text:en_US-shared/client/components/users/UserRank-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-shared/client/components/users/UserRank-1741125846000","value":{"rankName":"{rankName}","userRank":"Author rank {rankName}"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageTime-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageTime-1741125846000","value":{"postTime":"Published: {time}","lastPublishTime":"Last Update: {time}","conversation.lastPostingActivityTime":"Last posting activity time: {time}","conversation.lastPostTime":"Last post time: {time}","moderationData.rejectTime":"Rejected time: {time}"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageSolvedBadge-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageSolvedBadge-1741125846000","value":{"solved":"Solved"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageSubject-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageSubject-1741125846000","value":{"noSubject":"(no subject)"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageBody-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageBody-1741125846000","value":{"showMessageBody":"Show More","mentionsErrorTitle":"{mentionsType, select, board {Board} user {User} message {Message} other {}} No Longer Available","mentionsErrorMessage":"The {mentionsType} you are trying to view has been removed from the community.","videoProcessing":"Video is being processed. Please try again in a few minutes.","bannerTitle":"Video provider requires cookies to play the video. Accept to continue or {url} it directly on the provider's site.","buttonTitle":"Accept","urlText":"watch"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageCustomFields-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageCustomFields-1741125846000","value":{"CustomField.default.label":"Value of {name}"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageReplyButton-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageReplyButton-1741125846000","value":{"repliesCount":"{count}","title":"Reply","title@board:BLOG@message:root":"Comment","title@board:TKB@message:root":"Comment","title@board:IDEA@message:root":"Comment","title@board:OCCASION@message:root":"Comment"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageSolutionList-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageSolutionList-1741125846000","value":{"emptyDescription":"No has been message solutions yet"},"localOverride":false},"CachedAsset:text:en_US-components/messages/AcceptedSolutionButton-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/AcceptedSolutionButton-1741125846000","value":{"accept":"Mark as Solution","accepted":"Marked as Solution","errorHeader":"Error!","errorAdd":"There was an error marking as solution.","errorRemove":"There was an error unmarking as solution.","solved":"Solved","topicAlreadySolvedErrorTitle":"Solution Already Exists","topicAlreadySolvedErrorDesc":"Refresh the browser to view the existing solution"},"localOverride":false},"CachedAsset:text:en_US-shared/client/components/common/Pager/PagerLoadMore-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-shared/client/components/common/Pager/PagerLoadMore-1741125846000","value":{"loadMore":"Show More"},"localOverride":false},"CachedAsset:text:en_US-components/messages/MessageView/MessageViewInline-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/messages/MessageView/MessageViewInline-1741125846000","value":{"bylineAuthor":"{bylineAuthor}","bylineBoard":"{bylineBoard}","anonymous":"Anonymous","place":"Place {bylineBoard}","gotoParent":"Go to parent {name}"},"localOverride":false},"Revision:revision:185379_1":{"__typename":"Revision","id":"revision:185379_1","lastEditTime":"2019-06-03T07:59:35.502-07:00"},"Revision:revision:185380_1":{"__typename":"Revision","id":"revision:185380_1","lastEditTime":"2019-06-03T08:02:33.872-07:00"},"Revision:revision:185385_1":{"__typename":"Revision","id":"revision:185385_1","lastEditTime":"2019-06-03T08:44:17.810-07:00"},"User:user:67232":{"__typename":"User","id":"user:67232","uid":67232,"login":"RonRatovsky","biography":null,"registrationData":{"__typename":"RegistrationData","status":null,"registrationTime":"2015-07-13T08:53:22.164-07:00"},"deleted":false,"email":"","avatar":{"__typename":"UserAvatar","url":"https://community.smartbear.com/t5/s/nwkab66374/m_assets/avatars/default/avatar-2.svg?time=0"},"entityType":"USER","eventPath":"community:nwkab66374/user:67232","rank":{"__ref":"Rank:rank:3"}},"ForumReplyMessage:message:186395":{"__typename":"ForumReplyMessage","uid":186395,"id":"message:186395","revisionNum":2,"author":{"__ref":"User:user:84150"},"readOnly":false},"ModerationData:moderation_data:186397":{"__typename":"ModerationData","id":"moderation_data:186397","status":"APPROVED","rejectReason":null,"isReportedAbuse":false,"rejectUser":null,"rejectTime":null,"rejectActorType":null},"AcceptedSolutionMessage:message:186397":{"__typename":"AcceptedSolutionMessage","author":{"__ref":"User:user:67232"},"id":"message:186397","revisionNum":1,"uid":186397,"depth":8,"hasGivenKudo":false,"subscribed":false,"board":{"__ref":"Forum:board:SwaggerOSTools"},"parent":{"__ref":"ForumReplyMessage:message:186395"},"conversation":{"__ref":"Conversation:conversation:185303"},"subject":"Re: Examples for enum Choices","moderationData":{"__ref":"ModerationData:moderation_data:186397"},"body":"
\n # Or with multiple examples\n # (but this is not supported in Swagger UI and Editor yet)\n # examples:\n # user_key:\n # summary: Example of a user key\n # value: abcde12345\n # email_address:\n # summary: Example of an email address\n # value: 'user@example.com'
No, there's no way to describe mutually exclusive parameters.
","body@stripHtml({\"removeProcessingText\":true,\"removeSpoilerMarkup\":true,\"removeTocMarkup\":true,\"truncateLength\":200})@stringLength":"63","postTime":"2019-06-24T13:45:50.080-07:00","lastPublishTime":"2019-06-24T13:45:50.080-07:00","images":{"__typename":"AssociatedImageConnection","edges":[],"totalCount":0,"pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null}},"attachments":{"__typename":"AttachmentConnection","pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null},"edges":[]},"solution":true,"metrics":{"__typename":"MessageMetrics","views":8743},"placeholder":false,"originalMessageForPlaceholder":null,"videos":{"__typename":"VideoConnection","edges":[],"totalCount":0,"pageInfo":{"__typename":"PageInfo","hasNextPage":false,"endCursor":null,"hasPreviousPage":false,"startCursor":null}},"isEscalated":null,"entityType":"FORUM_REPLY","eventPath":"category:swagger-os-community/community:nwkab66374board:SwaggerOSTools/message:185303/message:186397","customFields":[],"readOnly":false,"editFrozen":false,"body@stringLength":"68","rawBody":"No, there's no way to describe mutually exclusive parameters.
","kudosSumWeight":0,"repliesCount":0,"timeToRead":1,"currentRevision":{"__ref":"Revision:revision:186397_1"},"latestVersion":null,"visibilityScope":"PUBLIC","messagePolicies":{"__typename":"MessagePolicies","canModerateSpamMessage":{"__typename":"PolicyResult","failureReason":{"__typename":"FailureReason","message":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","key":"error.lithium.policies.feature.moderation_spam.action.moderate_entity.allowed.accessDenied","args":[]}}}},"CachedAsset:text:en_US-shared/client/components/users/UserAvatar-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-shared/client/components/users/UserAvatar-1741125846000","value":{"altText":"{login}'s avatar","altTextGeneric":"User's avatar"},"localOverride":false},"CachedAsset:text:en_US-shared/client/components/ranks/UserRankLabel-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-shared/client/components/ranks/UserRankLabel-1741125846000","value":{"altTitle":"Icon for {rankName} rank"},"localOverride":false},"CachedAsset:text:en_US-components/attachments/AttachmentView/AttachmentViewChip-1741125846000":{"__typename":"CachedAsset","id":"text:en_US-components/attachments/AttachmentView/AttachmentViewChip-1741125846000","value":{"errorTitle":"Failed!","previewFile":"Preview File","downloadFile":"Download File {name}","removeFile":"Remove File {name}","errorBadExtension":"This file does not have a valid extension. \"{extensions}\" are the valid extensions.","errorFileEmpty":"This file is empty or does not exist.","errorTooLarge":"The maximum file size is: {maxFileSize}.","errorTooMany":"Too many attachments. The maximum number of attachments per message is: {maxAttachmentCount, number, integer}.","errorDuplicate":"This file is already attached."},"localOverride":false},"AssociatedImage:{\"url\":\"https://community.smartbear.com/t5/s/nwkab66374/images/cmstMy1yRDhvZGE\"}":{"__typename":"AssociatedImage","url":"https://community.smartbear.com/t5/s/nwkab66374/images/cmstMy1yRDhvZGE","height":64,"width":64,"mimeType":"image/png"},"Rank:rank:3":{"__typename":"Rank","id":"rank:3","position":2,"name":"Staff","color":"28B1FD","icon":{"__ref":"AssociatedImage:{\"url\":\"https://community.smartbear.com/t5/s/nwkab66374/images/cmstMy1yRDhvZGE\"}"},"rankStyle":"FILLED"},"Revision:revision:186397_1":{"__typename":"Revision","id":"revision:186397_1","lastEditTime":"2019-06-24T13:45:50.080-07:00"}}}},"page":"/forums/ForumMessagePage/ForumMessagePage","query":{"boardId":"swaggerostools","messageSubject":"examples-for-enum-choices","messageId":"185303"},"buildId":"q_bLpq2mflH0BeZigxpj6","runtimeConfig":{"buildInformationVisible":false,"logLevelApp":"info","logLevelMetrics":"info","openTelemetryClientEnabled":false,"openTelemetryConfigName":"smartbear","openTelemetryServiceVersion":"25.2.0","openTelemetryUniverse":"prod","openTelemetryCollector":"http://localhost:4318","openTelemetryRouteChangeAllowedTime":"5000","apolloDevToolsEnabled":false,"inboxMuteWipFeatureEnabled":false},"isFallback":false,"isExperimentalCompile":false,"dynamicIds":["./components/seo/QAPageSchema/QAPageSchema.tsx","./components/community/Navbar/NavbarWidget.tsx","./components/community/Breadcrumb/BreadcrumbWidget.tsx","./components/messages/TopicWithThreadedReplyListWidget/TopicWithThreadedReplyListWidget.tsx","./components/messages/MessageListForNodeByRecentActivityWidget/MessageListForNodeByRecentActivityWidget.tsx","./components/messages/RelatedContentWidget/RelatedContentWidget.tsx","./components/customComponent/CustomComponent/CustomComponent.tsx","./components/messages/MessageView/MessageViewStandard/MessageViewStandard.tsx","./components/messages/ThreadedReplyList/ThreadedReplyList.tsx","../shared/client/components/common/List/UnstyledList/UnstyledList.tsx","./components/messages/MessageView/MessageView.tsx","../shared/client/components/common/Pager/PagerLoadMore/PagerLoadMore.tsx","./components/messages/MessageView/MessageViewInline/MessageViewInline.tsx","./components/customComponent/CustomComponentContent/TemplateContent.tsx","../shared/client/components/common/List/UnwrappedList/UnwrappedList.tsx","./components/attachments/AttachmentView/AttachmentView.tsx","./components/attachments/AttachmentView/AttachmentViewChip/AttachmentViewChip.tsx"],"appGip":true,"scriptLoader":[]}