Skip to content

Conversation

@HavenDV
Copy link
Owner

@HavenDV HavenDV commented Sep 23, 2025

Summary by CodeRabbit

  • New Features
    • Team API responses now include ownership details (type, organization_id, enterprise_id) and LDAP DN information for improved clarity.
  • Refactor
    • Clarified operation names for repository custom properties endpoints to better reflect behavior.
    • Secret scanning alert list responses now return the value as an array of objects (was a single object).
  • Documentation
    • Updated external documentation links for attestations endpoints.
  • Chores
    • Adjusted metadata/categories for certain organization-related endpoints to align with attestations.

@coderabbitai
Copy link

coderabbitai bot commented Sep 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The OpenAPI spec in src/libs/GitHub/openapi.yaml was updated: documentation links adjusted, operationIds renamed for repository custom properties, team-related schemas expanded with ownership and LDAP fields, a new ldap-dn schema introduced, and secret-scanning alert list value fields changed from object to array.

Changes

Cohort / File(s) Summary of Changes
Docs link updates
src/libs/GitHub/openapi.yaml
Updated externalDocs URLs for attestations endpoints from orgs#… to orgs/attestations#…. Adjusted categories/subcategories to align with attestations.
Custom properties operationId renames
src/libs/GitHub/openapi.yaml
Renamed operationIds: repos/get-custom-properties-values → repos/custom-properties-for-repos-get-repository-values; repos/create-or-update-custom-properties-values → repos/custom-properties-for-repos-create-or-update-repository-values.
Team schema ownership + LDAP additions
src/libs/GitHub/openapi.yaml
Added fields to team-related schemas: type (enum: enterprise, organization), organization_id, enterprise_id. Introduced ldap-dn schema and referenced it across team-full and related components. Some required lists updated to include type.
Secret scanning list shape change
src/libs/GitHub/openapi.yaml
Changed organization-secret-scanning-alert-list.value and secret-scanning-alert-list.value from a single object { number } to an array of such objects.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

Thump-thump my paws on YAML plains,
New IDs hop through schema lanes.
Teams wear badges—org or ‘prise,
LDAP trails with tidy ties.
Secret scans now march in queues—
Arrays of numbers, lined-up views.
Carrot commits, reviewed with chews. 🥕🐇

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bot/update-openapi_202509230609

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fbfdb06 and 998ce5e.

⛔ Files ignored due to path filters (44)
  • src/libs/GitHub/Generated/GitHub..JsonSerializerContext.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.IReposClient.ReposCustomPropertiesForReposCreateOrUpdateRepositoryValues.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.IReposClient.ReposCustomPropertiesForReposGetRepositoryValues.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.NullableTeamSimpleType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.NullableTeamSimpleTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamFullType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamFullTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamRoleAssignmentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamRoleAssignmentTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamSimpleType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamSimpleTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.TeamTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeam1ParentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeam1ParentTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeam1Type.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeam1TypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeamParentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeamParentTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeamType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonConverters.WebhooksTeamTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.NullableTeamSimple.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.NullableTeamSimpleType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.ReposCustomPropertiesForReposCreateOrUpdateRepositoryValuesRequest.Json.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.ReposCustomPropertiesForReposCreateOrUpdateRepositoryValuesRequest.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.Team.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamFull.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamFullType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamRoleAssignment.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamRoleAssignmentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamSimple.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamSimpleType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.TeamType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeam.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeam1.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeam1Parent.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeam1ParentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeam1Type.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeamParent.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeamParentType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.Models.WebhooksTeamType.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.ReposClient.ReposCustomPropertiesForReposCreateOrUpdateRepositoryValues.g.cs is excluded by !**/generated/**
  • src/libs/GitHub/Generated/GitHub.ReposClient.ReposCustomPropertiesForReposGetRepositoryValues.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/GitHub/openapi.yaml (25 hunks)

Warning

Tools execution failed with the following error:

Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error)


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot merged commit 91a9c7a into main Sep 23, 2025
1 of 3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update OpenAPI: docs links, opIds, team schemas, LDAP, alerts arrays Sep 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants