Fix Javadoc errors and add CI validation (#36)

* Fix Javadoc errors and add CI validation

- Fix malformed HTML in GroupCreate.java and GroupRead.java by wrapping
  <resource_key:resource_instance_key> with {@code ...}
- Add javadoc.yaml workflow to validate Javadoc on PRs and master pushes
- Update publish.yaml to verify Javadoc before publishing

Fixes PER-13670

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Update src/main/java/io/permit/sdk/openapi/models/GroupCreate.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/main/java/io/permit/sdk/openapi/models/GroupRead.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* wip

* Exclude generated OpenAPI models from javadoc

- Add javadoc task exclusion for io/permit/sdk/openapi/models/**
- Mark folder as linguist-generated in .gitattributes for GitHub

This reduces javadoc warnings from 100+ to 1 and collapses
generated code diffs in GitHub PRs.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Revert javadoc fixes in generated files

The generated OpenAPI models are now excluded from javadoc generation
in build.gradle, so we don't need to fix the javadoc in these files.
This keeps the generated files closer to their original state.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* wip

* Update .github/workflows/javadoc.yaml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add missing @param description in ElementsLoginResult

Fixes the last remaining Javadoc warning.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

.gitattributes

@@ -4,3 +4,6 @@
 # These are explicitly windows files and should use crlf
 *.bat           text eol=crlf
 
+# Mark generated OpenAPI models as generated code
+# This collapses diffs in PRs and excludes from language statistics
+src/main/java/io/permit/sdk/openapi/models/** linguist-generated=true

.github/workflows/javadoc.yaml

@@ -0,0 +1,33 @@
+name: Javadoc Verification
+
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+
+jobs:
+  javadoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v3.11.0
+        with:
+          java-version: '8'
+          distribution: 'corretto'
+      - name: Validate Gradle wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - name: Generate Javadoc
+        uses: gradle/gradle-build-action@v2
+        with:
+          arguments: javadoc
+      - name: Check Javadoc generation
+        run: |
+          if [ -d "build/docs/javadoc" ]; then
+            echo "Javadoc generated successfully"
+            echo "Javadoc files:"
+            find build/docs/javadoc -name "*.html" | head -20
+          else
+            echo "ERROR: Javadoc directory not found"
+            exit 1
+          fi

.github/workflows/publish.yaml

@@ -1,15 +1,15 @@
 name: Publish package to GitHub Packages
 on:
   release:
-    types: [created]
+    types: [ created ]
   workflow_dispatch:
-  
+
 jobs:
   publish:
-    runs-on: ubuntu-latest 
-    permissions: 
+    runs-on: ubuntu-latest
+    permissions:
       contents: read
-      packages: write 
+      packages: write
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-java@v3.11.0
@@ -18,6 +18,18 @@ jobs:
           distribution: 'corretto'
       - name: Validate Gradle wrapper
         uses: gradle/wrapper-validation-action@v1
+      - name: Verify Javadoc generation
+        uses: gradle/gradle-build-action@v2
+        with:
+          arguments: javadoc
+      - name: Check Javadoc generation
+        run: |
+          if [ -d "build/docs/javadoc" ]; then
+            echo "Javadoc verified successfully"
+          else
+            echo "ERROR: Javadoc directory not found"
+            exit 1
+          fi
       - name: Publish package
         uses: gradle/gradle-build-action@v2
         with:
@@ -29,4 +41,4 @@ jobs:
           GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
           GPG_SIGNING_PASSPHRASE: ${{ secrets.GPG_SIGNING_PASSPHRASE }}
           NEXUS_TOKEN_USERNAME: ${{ secrets.NEXUS_TOKEN_USERNAME }}
-          NEXUS_TOKEN_PASSWORD: ${{ secrets.NEXUS_TOKEN_PASSWORD }}
+          NEXUS_TOKEN_PASSWORD: ${{ secrets.NEXUS_TOKEN_PASSWORD }}

build.gradle

@@ -225,6 +225,11 @@ tasks.named('test') {
     useJUnitPlatform()
 }
 
+tasks.named('javadoc') {
+    // Exclude generated OpenAPI models from javadoc generation
+    exclude 'io/permit/sdk/openapi/models/**'
+}
+
 tasks.named('jar') {
     manifest {
         attributes('Implementation-Title': project.name,

src/main/java/io/permit/sdk/api/models/ElementsLoginResult.java

@@ -17,8 +17,7 @@ public ElementsLoginResult() {
     }
 
     /**
-     *
-     * @param redirectUrl
+     * @param redirectUrl The URL to redirect the user to after login
      */
     public ElementsLoginResult(String redirectUrl) {
         super(redirectUrl);