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

OpenAPI: Hide inaccessible links #1518

Merged
merged 6 commits into from
Mar 27, 2024
Merged

OpenAPI: Hide inaccessible links #1518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
60a7206
Use post-processing step to cleanup unused component schemas
bkoelman Mar 23, 2024
8cc8220
Remove [Required] usage on links, because all links can be turned off
bkoelman Mar 23, 2024
4ba9f40
Renames for parity with JSON:API terminology
bkoelman Mar 24, 2024
6b6cf38
Fixed: make relationship links non-required
bkoelman Mar 26, 2024
5ab8b22
Hide links that are inaccessible
bkoelman Mar 25, 2024
7722b87
Add test for alternate Swagger route
bkoelman Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
286 changes: 120 additions & 166 deletions src/Examples/JsonApiDotNetCoreExample/GeneratedSwagger/JsonApiDotNetCoreExample.json
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/Assignee.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ public PersonAttributesInResponse Attributes {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInResourceData? Links {
get { return BackingStore?.Get<LinksInResourceData?>("links"); }
public ResourceLinks? Links {
get { return BackingStore?.Get<ResourceLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInResourceData Links {
get { return BackingStore?.Get<LinksInResourceData>("links"); }
public ResourceLinks Links {
get { return BackingStore?.Get<ResourceLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -76,7 +76,7 @@ public PersonRelationshipsInResponse Relationships {
public override IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>>(base.GetFieldDeserializers()) {
{"attributes", n => { Attributes = n.GetObjectValue<PersonAttributesInResponse>(PersonAttributesInResponse.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<LinksInResourceData>(LinksInResourceData.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ResourceLinks>(ResourceLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<Assignee_meta>(Assignee_meta.CreateFromDiscriminatorValue); } },
{"relationships", n => { Relationships = n.GetObjectValue<PersonRelationshipsInResponse>(PersonRelationshipsInResponse.CreateFromDiscriminatorValue); } },
};
Expand All @@ -89,7 +89,7 @@ public override void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
base.Serialize(writer);
writer.WriteObjectValue<PersonAttributesInResponse>("attributes", Attributes);
writer.WriteObjectValue<LinksInResourceData>("links", Links);
writer.WriteObjectValue<ResourceLinks>("links", Links);
writer.WriteObjectValue<Assignee_meta>("meta", Meta);
writer.WriteObjectValue<PersonRelationshipsInResponse>("relationships", Relationships);
}
Expand Down
12 changes: 6 additions & 6 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/ErrorResponseDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ public List<ErrorObject> Errors {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInErrorDocument? Links {
get { return BackingStore?.Get<LinksInErrorDocument?>("links"); }
public ErrorTopLevelLinks? Links {
get { return BackingStore?.Get<ErrorTopLevelLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInErrorDocument Links {
get { return BackingStore?.Get<LinksInErrorDocument>("links"); }
public ErrorTopLevelLinks Links {
get { return BackingStore?.Get<ErrorTopLevelLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -74,7 +74,7 @@ public static ErrorResponseDocument CreateFromDiscriminatorValue(IParseNode pars
public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>> {
{"errors", n => { Errors = n.GetCollectionOfObjectValues<ErrorObject>(ErrorObject.CreateFromDiscriminatorValue)?.ToList(); } },
{"links", n => { Links = n.GetObjectValue<LinksInErrorDocument>(LinksInErrorDocument.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ErrorTopLevelLinks>(ErrorTopLevelLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<ErrorResponseDocument_meta>(ErrorResponseDocument_meta.CreateFromDiscriminatorValue); } },
};
}
Expand All @@ -85,7 +85,7 @@ public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
public virtual void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
writer.WriteCollectionOfObjectValues<ErrorObject>("errors", Errors);
writer.WriteObjectValue<LinksInErrorDocument>("links", Links);
writer.WriteObjectValue<ErrorTopLevelLinks>("links", Links);
writer.WriteObjectValue<ErrorResponseDocument_meta>("meta", Meta);
}
}
Expand Down
10 changes: 5 additions & 5 deletions ...eratedCode/Models/LinksInErrorDocument.cs → ...eneratedCode/Models/ErrorTopLevelLinks.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
using System.Linq;
using System;
namespace OpenApiKiotaClientExample.GeneratedCode.Models {
public class LinksInErrorDocument : IBackedModel, IParsable {
public class ErrorTopLevelLinks : IBackedModel, IParsable {
/// <summary>Stores model information.</summary>
public IBackingStore BackingStore { get; private set; }
/// <summary>The describedby property</summary>
Expand Down Expand Up @@ -38,18 +38,18 @@ public string Self {
}
#endif
/// <summary>
/// Instantiates a new linksInErrorDocument and sets the default values.
/// Instantiates a new errorTopLevelLinks and sets the default values.
/// </summary>
public LinksInErrorDocument() {
public ErrorTopLevelLinks() {
BackingStore = BackingStoreFactorySingleton.Instance.CreateBackingStore();
}
/// <summary>
/// Creates a new instance of the appropriate class based on discriminator value
/// </summary>
/// <param name="parseNode">The parse node to use to read the discriminator value and create the object</param>
public static LinksInErrorDocument CreateFromDiscriminatorValue(IParseNode parseNode) {
public static ErrorTopLevelLinks CreateFromDiscriminatorValue(IParseNode parseNode) {
_ = parseNode ?? throw new ArgumentNullException(nameof(parseNode));
return new LinksInErrorDocument();
return new ErrorTopLevelLinks();
}
/// <summary>
/// The deserialization information for the current model
Expand Down
12 changes: 6 additions & 6 deletions ...penApiKiotaClientExample/GeneratedCode/Models/NullablePersonIdentifierResponseDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ public PersonIdentifier Data {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInResourceIdentifierDocument? Links {
get { return BackingStore?.Get<LinksInResourceIdentifierDocument?>("links"); }
public ResourceIdentifierTopLevelLinks? Links {
get { return BackingStore?.Get<ResourceIdentifierTopLevelLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInResourceIdentifierDocument Links {
get { return BackingStore?.Get<LinksInResourceIdentifierDocument>("links"); }
public ResourceIdentifierTopLevelLinks Links {
get { return BackingStore?.Get<ResourceIdentifierTopLevelLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -71,7 +71,7 @@ public static NullablePersonIdentifierResponseDocument CreateFromDiscriminatorVa
public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>> {
{"data", n => { Data = n.GetObjectValue<PersonIdentifier>(PersonIdentifier.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<LinksInResourceIdentifierDocument>(LinksInResourceIdentifierDocument.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ResourceIdentifierTopLevelLinks>(ResourceIdentifierTopLevelLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<NullablePersonIdentifierResponseDocument_meta>(NullablePersonIdentifierResponseDocument_meta.CreateFromDiscriminatorValue); } },
};
}
Expand All @@ -82,7 +82,7 @@ public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
public virtual void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
writer.WriteObjectValue<PersonIdentifier>("data", Data);
writer.WriteObjectValue<LinksInResourceIdentifierDocument>("links", Links);
writer.WriteObjectValue<ResourceIdentifierTopLevelLinks>("links", Links);
writer.WriteObjectValue<NullablePersonIdentifierResponseDocument_meta>("meta", Meta);
}
}
Expand Down
12 changes: 6 additions & 6 deletions ...OpenApiKiotaClientExample/GeneratedCode/Models/NullablePersonSecondaryResponseDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ public List<DataInResponse> Included {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInResourceDocument? Links {
get { return BackingStore?.Get<LinksInResourceDocument?>("links"); }
public ResourceTopLevelLinks? Links {
get { return BackingStore?.Get<ResourceTopLevelLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInResourceDocument Links {
get { return BackingStore?.Get<LinksInResourceDocument>("links"); }
public ResourceTopLevelLinks Links {
get { return BackingStore?.Get<ResourceTopLevelLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -86,7 +86,7 @@ public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>> {
{"data", n => { Data = n.GetObjectValue<Assignee>(Assignee.CreateFromDiscriminatorValue); } },
{"included", n => { Included = n.GetCollectionOfObjectValues<DataInResponse>(DataInResponse.CreateFromDiscriminatorValue)?.ToList(); } },
{"links", n => { Links = n.GetObjectValue<LinksInResourceDocument>(LinksInResourceDocument.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ResourceTopLevelLinks>(ResourceTopLevelLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<NullablePersonSecondaryResponseDocument_meta>(NullablePersonSecondaryResponseDocument_meta.CreateFromDiscriminatorValue); } },
};
}
Expand All @@ -98,7 +98,7 @@ public virtual void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
writer.WriteObjectValue<Assignee>("data", Data);
writer.WriteCollectionOfObjectValues<DataInResponse>("included", Included);
writer.WriteObjectValue<LinksInResourceDocument>("links", Links);
writer.WriteObjectValue<ResourceTopLevelLinks>("links", Links);
writer.WriteObjectValue<NullablePersonSecondaryResponseDocument_meta>("meta", Meta);
}
}
Expand Down
12 changes: 6 additions & 6 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/NullableToOnePersonInResponse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ public PersonIdentifier Data {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInRelationship? Links {
get { return BackingStore?.Get<LinksInRelationship?>("links"); }
public RelationshipLinks? Links {
get { return BackingStore?.Get<RelationshipLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInRelationship Links {
get { return BackingStore?.Get<LinksInRelationship>("links"); }
public RelationshipLinks Links {
get { return BackingStore?.Get<RelationshipLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -71,7 +71,7 @@ public static NullableToOnePersonInResponse CreateFromDiscriminatorValue(IParseN
public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>> {
{"data", n => { Data = n.GetObjectValue<PersonIdentifier>(PersonIdentifier.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<LinksInRelationship>(LinksInRelationship.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<RelationshipLinks>(RelationshipLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<NullableToOnePersonInResponse_meta>(NullableToOnePersonInResponse_meta.CreateFromDiscriminatorValue); } },
};
}
Expand All @@ -82,7 +82,7 @@ public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
public virtual void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
writer.WriteObjectValue<PersonIdentifier>("data", Data);
writer.WriteObjectValue<LinksInRelationship>("links", Links);
writer.WriteObjectValue<RelationshipLinks>("links", Links);
writer.WriteObjectValue<NullableToOnePersonInResponse_meta>("meta", Meta);
}
}
Expand Down
12 changes: 6 additions & 6 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/Owner.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ public PersonAttributesInResponse Attributes {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInResourceData? Links {
get { return BackingStore?.Get<LinksInResourceData?>("links"); }
public ResourceLinks? Links {
get { return BackingStore?.Get<ResourceLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInResourceData Links {
get { return BackingStore?.Get<LinksInResourceData>("links"); }
public ResourceLinks Links {
get { return BackingStore?.Get<ResourceLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -76,7 +76,7 @@ public PersonRelationshipsInResponse Relationships {
public override IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>>(base.GetFieldDeserializers()) {
{"attributes", n => { Attributes = n.GetObjectValue<PersonAttributesInResponse>(PersonAttributesInResponse.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<LinksInResourceData>(LinksInResourceData.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ResourceLinks>(ResourceLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<Owner_meta>(Owner_meta.CreateFromDiscriminatorValue); } },
{"relationships", n => { Relationships = n.GetObjectValue<PersonRelationshipsInResponse>(PersonRelationshipsInResponse.CreateFromDiscriminatorValue); } },
};
Expand All @@ -89,7 +89,7 @@ public override void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
base.Serialize(writer);
writer.WriteObjectValue<PersonAttributesInResponse>("attributes", Attributes);
writer.WriteObjectValue<LinksInResourceData>("links", Links);
writer.WriteObjectValue<ResourceLinks>("links", Links);
writer.WriteObjectValue<Owner_meta>("meta", Meta);
writer.WriteObjectValue<PersonRelationshipsInResponse>("relationships", Relationships);
}
Expand Down
12 changes: 6 additions & 6 deletions src/Examples/OpenApiKiotaClientExample/GeneratedCode/Models/People.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ public PersonAttributesInResponse Attributes {
/// <summary>The links property</summary>
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_1_OR_GREATER
#nullable enable
public LinksInResourceData? Links {
get { return BackingStore?.Get<LinksInResourceData?>("links"); }
public ResourceLinks? Links {
get { return BackingStore?.Get<ResourceLinks?>("links"); }
set { BackingStore?.Set("links", value); }
}
#nullable restore
#else
public LinksInResourceData Links {
get { return BackingStore?.Get<LinksInResourceData>("links"); }
public ResourceLinks Links {
get { return BackingStore?.Get<ResourceLinks>("links"); }
set { BackingStore?.Set("links", value); }
}
#endif
Expand Down Expand Up @@ -76,7 +76,7 @@ public PersonRelationshipsInResponse Relationships {
public override IDictionary<string, Action<IParseNode>> GetFieldDeserializers() {
return new Dictionary<string, Action<IParseNode>>(base.GetFieldDeserializers()) {
{"attributes", n => { Attributes = n.GetObjectValue<PersonAttributesInResponse>(PersonAttributesInResponse.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<LinksInResourceData>(LinksInResourceData.CreateFromDiscriminatorValue); } },
{"links", n => { Links = n.GetObjectValue<ResourceLinks>(ResourceLinks.CreateFromDiscriminatorValue); } },
{"meta", n => { Meta = n.GetObjectValue<People_meta>(People_meta.CreateFromDiscriminatorValue); } },
{"relationships", n => { Relationships = n.GetObjectValue<PersonRelationshipsInResponse>(PersonRelationshipsInResponse.CreateFromDiscriminatorValue); } },
};
Expand All @@ -89,7 +89,7 @@ public override void Serialize(ISerializationWriter writer) {
_ = writer ?? throw new ArgumentNullException(nameof(writer));
base.Serialize(writer);
writer.WriteObjectValue<PersonAttributesInResponse>("attributes", Attributes);
writer.WriteObjectValue<LinksInResourceData>("links", Links);
writer.WriteObjectValue<ResourceLinks>("links", Links);
writer.WriteObjectValue<People_meta>("meta", Meta);
writer.WriteObjectValue<PersonRelationshipsInResponse>("relationships", Relationships);
}
Expand Down
Loading